<!-- HTML header for doxygen 1.8.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<title>OpenCV: cv::gapi::wip::IStreamSource Class Reference</title>
<link href="../../opencv.ico" rel="shortcut icon" type="image/x-icon" />
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<script type="text/javascript" src="../../tutorial-utils.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
//<![CDATA[
MathJax.Hub.Config(
{
  TeX: {
      Macros: {
          matTT: [ "\\[ \\left|\\begin{array}{ccc} #1 & #2 & #3\\\\ #4 & #5 & #6\\\\ #7 & #8 & #9 \\end{array}\\right| \\]", 9],
          fork: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ \\end{array} \\right.", 4],
          forkthree: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ #5 & \\mbox{#6}\\\\ \\end{array} \\right.", 6],
          forkfour: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ #5 & \\mbox{#6}\\\\ #7 & \\mbox{#8}\\\\ \\end{array} \\right.", 8],
          vecthree: ["\\begin{bmatrix} #1\\\\ #2\\\\ #3 \\end{bmatrix}", 3],
          vecthreethree: ["\\begin{bmatrix} #1 & #2 & #3\\\\ #4 & #5 & #6\\\\ #7 & #8 & #9 \\end{bmatrix}", 9],
          cameramatrix: ["#1 = \\begin{bmatrix} f_x & 0 & c_x\\\\ 0 & f_y & c_y\\\\ 0 & 0 & 1 \\end{bmatrix}", 1],
          distcoeffs: ["(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]]) \\text{ of 4, 5, 8, 12 or 14 elements}"],
          distcoeffsfisheye: ["(k_1, k_2, k_3, k_4)"],
          hdotsfor: ["\\dots", 1],
          mathbbm: ["\\mathbb{#1}", 1],
          bordermatrix: ["\\matrix{#1}", 1]
      }
  }
}
);
//]]>
</script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
<link href="../../stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<!--#include virtual="/google-search.html"-->
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="../../opencv-logo-small.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">OpenCV
   &#160;<span id="projectnumber">4.5.2</span>
   </div>
   <div id="projectbrief">Open Source Computer Vision</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="../../d2/d75/namespacecv.html">cv</a></li><li class="navelem"><a class="el" href="../../d4/d1c/namespacecv_1_1gapi.html">gapi</a></li><li class="navelem"><a class="el" href="../../dd/de9/namespacecv_1_1gapi_1_1wip.html">wip</a></li><li class="navelem"><a class="el" href="../../da/d03/classcv_1_1gapi_1_1wip_1_1IStreamSource.html">IStreamSource</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../df/dd0/classcv_1_1gapi_1_1wip_1_1IStreamSource-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">cv::gapi::wip::IStreamSource Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Abstract streaming pipeline source.  
 <a href="../../da/d03/classcv_1_1gapi_1_1wip_1_1IStreamSource.html#details">More...</a></p>

<p><code>#include &lt;opencv2/gapi/streaming/source.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for cv::gapi::wip::IStreamSource:</div>
<div class="dyncontent">
 <div class="center">
  <img src="../../da/d03/classcv_1_1gapi_1_1wip_1_1IStreamSource.png" usemap="#cv::gapi::wip::IStreamSource_map" alt=""/>
  <map id="cv::gapi::wip::IStreamSource_map" name="cv::gapi::wip::IStreamSource_map">
<area href="../../dd/d1c/classcv_1_1gapi_1_1wip_1_1GCaptureSource.html" title="OpenCV&#39;s VideoCapture-based streaming source. " alt="cv::gapi::wip::GCaptureSource" shape="rect" coords="0,112,283,136"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:afa9caf180bca701df9b10a6974eaa8ff"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d03/classcv_1_1gapi_1_1wip_1_1IStreamSource.html#afa9caf180bca701df9b10a6974eaa8ff">Ptr</a> = std::shared_ptr&lt; <a class="el" href="../../da/d03/classcv_1_1gapi_1_1wip_1_1IStreamSource.html">IStreamSource</a> &gt;</td></tr>
<tr class="separator:afa9caf180bca701df9b10a6974eaa8ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a24296442c24fa38de2944f69bbe6af81"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d03/classcv_1_1gapi_1_1wip_1_1IStreamSource.html#a24296442c24fa38de2944f69bbe6af81">~IStreamSource</a> ()=default</td></tr>
<tr class="separator:a24296442c24fa38de2944f69bbe6af81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a183343b6247b7a4ec24e8ec795795611"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="../../d2/d75/namespacecv.html#ad87531579f8dc910ba0579a9f5d779ab">GMetaArg</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d03/classcv_1_1gapi_1_1wip_1_1IStreamSource.html#a183343b6247b7a4ec24e8ec795795611">descr_of</a> () const =0</td></tr>
<tr class="separator:a183343b6247b7a4ec24e8ec795795611"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3d4f3f6fb1f275bd04d574b5add03d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../da/d03/classcv_1_1gapi_1_1wip_1_1IStreamSource.html#afa9caf180bca701df9b10a6974eaa8ff">Ptr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d03/classcv_1_1gapi_1_1wip_1_1IStreamSource.html#ad3d4f3f6fb1f275bd04d574b5add03d4">ptr</a> ()</td></tr>
<tr class="separator:ad3d4f3f6fb1f275bd04d574b5add03d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabf1343183c118fa2a5818d519fce4cc"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d03/classcv_1_1gapi_1_1wip_1_1IStreamSource.html#aabf1343183c118fa2a5818d519fce4cc">pull</a> (<a class="el" href="../../d7/d84/structcv_1_1gapi_1_1wip_1_1Data.html">Data</a> &amp;data)=0</td></tr>
<tr class="separator:aabf1343183c118fa2a5818d519fce4cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Abstract streaming pipeline source. </p>
<p>Implement this interface if you want customize the way how data is streaming into <a class="el" href="../../d1/d9b/classcv_1_1GStreamingCompiled.html" title="Represents a computation (graph) compiled for streaming. ">GStreamingCompiled</a>.</p>
<p>Objects implementing this interface can be passed to <a class="el" href="../../d1/d9b/classcv_1_1GStreamingCompiled.html" title="Represents a computation (graph) compiled for streaming. ">GStreamingCompiled</a> using setSource() with <a class="el" href="../../d2/d75/namespacecv.html#a4941eb8cbe70b8c7187bc8459af7653b">cv::gin()</a>. Regular compiled graphs (<a class="el" href="../../d2/d2c/classcv_1_1GCompiled.html" title="Represents a compiled computation (graph). Can only be used with image / data formats &amp; resolutions i...">GCompiled</a>) don't support input objects of this type.</p>
<p>Default <a class="el" href="../../d8/dfe/classcv_1_1VideoCapture.html" title="Class for video capturing from video files, image sequences or cameras. ">cv::VideoCapture</a>-based implementation is available, see <a class="el" href="../../dd/d1c/classcv_1_1gapi_1_1wip_1_1GCaptureSource.html" title="OpenCV&#39;s VideoCapture-based streaming source. ">cv::gapi::wip::GCaptureSource</a>.</p>
<dl class="section note"><dt>Note</dt><dd>stream sources are passed to G-API via shared pointers, so please use <a class="el" href="../../da/d03/classcv_1_1gapi_1_1wip_1_1IStreamSource.html#ad3d4f3f6fb1f275bd04d574b5add03d4">ptr()</a> when passing a <a class="el" href="../../da/d03/classcv_1_1gapi_1_1wip_1_1IStreamSource.html" title="Abstract streaming pipeline source. ">IStreamSource</a> implementation to <a class="el" href="../../d2/d75/namespacecv.html#a4941eb8cbe70b8c7187bc8459af7653b">cv::gin()</a>. </dd></dl>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="afa9caf180bca701df9b10a6974eaa8ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa9caf180bca701df9b10a6974eaa8ff">&#9670;&nbsp;</a></span>Ptr</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="../../da/d03/classcv_1_1gapi_1_1wip_1_1IStreamSource.html#afa9caf180bca701df9b10a6974eaa8ff">cv::gapi::wip::IStreamSource::Ptr</a> =  std::shared_ptr&lt;<a class="el" href="../../da/d03/classcv_1_1gapi_1_1wip_1_1IStreamSource.html">IStreamSource</a>&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a24296442c24fa38de2944f69bbe6af81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24296442c24fa38de2944f69bbe6af81">&#9670;&nbsp;</a></span>~IStreamSource()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual cv::gapi::wip::IStreamSource::~IStreamSource </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a183343b6247b7a4ec24e8ec795795611"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a183343b6247b7a4ec24e8ec795795611">&#9670;&nbsp;</a></span>descr_of()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="../../d2/d75/namespacecv.html#ad87531579f8dc910ba0579a9f5d779ab">GMetaArg</a> cv::gapi::wip::IStreamSource::descr_of </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="../../dd/d1c/classcv_1_1gapi_1_1wip_1_1GCaptureSource.html#ad92fceb8177f0fb129137f35d50dce93">cv::gapi::wip::GCaptureSource</a>.</p>

</div>
</div>
<a id="ad3d4f3f6fb1f275bd04d574b5add03d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3d4f3f6fb1f275bd04d574b5add03d4">&#9670;&nbsp;</a></span>ptr()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../da/d03/classcv_1_1gapi_1_1wip_1_1IStreamSource.html#afa9caf180bca701df9b10a6974eaa8ff">Ptr</a> cv::gapi::wip::IStreamSource::ptr </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="aabf1343183c118fa2a5818d519fce4cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabf1343183c118fa2a5818d519fce4cc">&#9670;&nbsp;</a></span>pull()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool cv::gapi::wip::IStreamSource::pull </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../d7/d84/structcv_1_1gapi_1_1wip_1_1Data.html">Data</a> &amp;&#160;</td>
          <td class="paramname"><em>data</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="../../dd/d1c/classcv_1_1gapi_1_1wip_1_1GCaptureSource.html#a51e5143c603dd8ca571ab6dd91215ec6">cv::gapi::wip::GCaptureSource</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>opencv2/gapi/streaming/<a class="el" href="../../d2/d2e/source_8hpp.html">source.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.6-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 2 2021 11:36:47 for OpenCV by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
<script type="text/javascript">
//<![CDATA[
addTutorialsButtons();
//]]>
</script>
</body>
</html>
